Renegociación
Esta API permite la renegociación y regularización de contratos con base en diferentes elegibilidades, ofreciendo diversas campañas para regularización y facilitando simulaciones antes de la efectivización del acuerdo. Además, es posible consultar los boletos generados después de la efectivización del acuerdo y/o cancelar la renegociación antes del pago de la cuota de adhesión (primera cuota).
Elegibilidad
La elegibilidad se refiere a uno o más métodos de renegociación y regularización de contratos en situación irregular. Las elegibilidades son preestablecidas por el equipo interno de gestión de contratos, pudiendo existir diferentes tipos, cada uno con criterios específicos. Tales diferencias pueden ser visibles en los campos type e installment_agreement_type, que poseen los respectivos valores:
type:
- TOTAL: prepago de un contrato único.
- WRAP: unificación de diferentes contratos, también llamado empaquetamiento.
installment_agreement_type:
- Disabled: solamente pago al contado del valor adeudado.
- OnlyVNP: solamente el pago de valores vencidos.
- NotVNP: solamente el prepago de valores futuros.
- All: permite todas las opciones anteriores.
Dado que no se genera un nuevo contrato con nuevas cuotas, plazos y valores, los pagos al contado del valor adeudado se consideran solamente como regularización; de lo contrario, se convierte en una renegociación. Una renegociación ofrece además la posibilidad de empaquetamiento, que no es más que la unificación de diferentes contratos con el objetivo de simplificar aún más el acuerdo con el deudor.
Es posible visualizar los contratos informando el fondo mediante el campo fund_tax_id y su respectivo cliente representado por customer_tax_id.
// ejemplo de respuesta:
[
{
"contracts": [
{
"balance": {
"curve_value": 3111.1,
"fixed_interest_value": 653.51,
"float_interest_value": 0,
"interest_arrears_value": 3.55,
"interest_value": 0,
"iof_fee_value": 0.32,
"late_payment_value": 0,
"penalty_fee_value": 22.47,
"principal_value": 2431.25,
"spread_rate": 49.190931
},
"contract": "AUX-55335009",
"cros_contract": "0002391480/RMD_TEST_022",
"due_days": 273,
"installments": [
{
"curve_value\"": 164.23,
"fixed_interest_value\"": 7.37,
"float_interest_value\"": 0,
"has_processing_payments": false,
"installment_number\"": 1,
"interest_arrears_value\"": 0.96,
"iof_value\"": 0.05,
"is_vnp": true,
"late_payment_value\"": 0,
"maturity_date": "2022-11-30T00:00:00",
"maturity_value\"": 160,
"penalty_fee_value\"": 3.22,
"principal_value\"": 152.63,
"status": "Opened"
}
],
"name": "FIDC MT Auxílio Brasil"
}
],
"description": "Reneg. Simples",
"id": "COL_RISK_POLICY_TEST",
"installment_agreement_type": "Disabled",
"type": "TOTAL"
}
]
Campaña
Una campaña representa una estrategia específica para la renegociación de contratos dentro de una determinada elegibilidad. Cada tipo de elegibilidad puede tener varias campañas asociadas a ella, ofreciendo opciones diversas para la regularización del contrato.
Por ejemplo, una campaña dentro de determinada elegibilidad puede ofrecer descuentos exclusivos, mientras que otra campaña para la misma elegibilidad puede proporcionar planes de pago diferenciados.
Es posible visualizar las campañas de uno o más contratos, contract[] informando el fondo mediante el campo fund_tax_id y su respectivo cliente representado por customer_tax_id.
// ejemplo de respuesta:
{
[
{
"affinity_score": 5,
"code": "123456",
"first_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"grace_period_flow": {
"max_value": 0,
"name": "Carência de Parcelas",
"type": "Cashflow"
},
"guarantor_type": "ORIGINAL",
"installment_agreement_type": "All",
"installment_ranges": [
{
"discount_fields": [
{
"percent": 0,
"text": "Principal",
"value": "Main"
}
],
"max_installments": 1,
"min_installments": 1
}
],
"installments_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"interest_payment_type": "Juros Originais",
"interest_rate": 0,
"minimum_installment_amount": 0.1,
"minimun_entry_amount": 155.56,
"name": "123456",
"payment_dates": [
"2023-08-30"
],
"payment_periodicity": null
}
]
}
Simulación
La etapa de simulación de una renegociación es la etapa en la que se valida de hecho si el cliente, identificado por customer_tax_id, está apto para utilizar determinada campaña disponible para el contrato, donde se verifican todos los valores y tasas incluidas en la campaña, identificada por campaign_code.
// ejemplo de respuesta:
{
"contracts": [
"CONTRACT-001"
],
"cros_contracts": [
"0000000000/CONTRACT_TEST_001"
],
"debt_current_values": 3100,
"debts": [
{
"channel": "fidc",
"company": {
"business_name": "BANCO BTG PACTUAL S.A.",
"id": "30306294000145"
},
"contract": "CONTRACT-001",
"cros_contract": "0000000000/CONTRACT_TEST_001",
"curve_value": 3100,
"due_date": "2022-10-07T00:00:00",
"due_days": 273,
"installments": [
{
"curve_value": 164.23,
"installment_number": 1,
"is_vnp": true,
"maturity_date": "2022-11-30T00:00:00",
"maturity_value": 160,
"principal_value": 152.63
}
],
"installments_count": 24,
"interest_value": 653.51,
"is_late": true,
"principal_value": 2431.25,
"product": "PRODUCT",
"product_description": "FIDC Product Description",
"product_type": 0,
"spread_rate": 49.190931,
"total_balance": 0,
"trade_id": "82743754",
"updated_at": "2023-07-07T00:00:00"
}
],
"eligibility": "TESTE_FIDC",
"first_payment_date": "2023-08-30",
"first_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"id": "ef1e7735-de4f-437b-af6c-3fcec6024e4c",
"input_value": 0,
"installment_options": [
{
"annual_interest_rate": 12059.314432,
"cet_rate": 100,
"current_value_discount_percentage": 0.45,
"current_value_discount_value": 14.15,
"discount_percentage": 0.83,
"installments": [
{
"amortization\"": 3122.96727565,
"balance\"": 0,
"discount\"": 26.02,
"discount_percentage\"": 0.8331819613634702,
"due_date\"": "2023-08-30T00:00:00",
"end_accrual\"": "2023-08-30T00:00:00",
"incorporated_days\"": 0,
"incorporation_flag\"": false,
"index\"": 1,
"installment_value\"": 3122.96727565,
"installment_value_with_discount\"": 3096.94727565,
"interest_value\"": 0,
"iof_value\"": 11.86727565,
"main_ticket\"": 3122.96727565,
"start_accrual\"": "2023-08-30T00:00:00"
}
],
"installments_count\"": 1,
"monthly_interest_rate\"": null,
"original_interest_rate\"": 49.190931,
"simulation_id\"": "c9076271-a5d3-482f-83b1-befec70f235f",
"total_discount_value\"": 26.02,
"total_fee_value\"": 0,
"total_interest_value\"": 0,
"total_iof_value\"": 11.86727565,
"total_value\"": 3122.96727565,
"total_value_with_discount\"": 3096.94727565
}
],
"installments_payment_options": [
{
"description": "Boleto",
"id": 1,
"name": "BANKSLIP"
}
],
"max_installments_count": 1,
"requested_installments": [
""
],
"requested_installments_count": 1,
"status": "OPEN"
}
Confirmación
Después de la simulación se obtendrá el valor del simulation_identification, que será necesario para confirmar el acuerdo, donde la renegociación se volverá de hecho efectiva. En esta etapa también es posible realizar el prepago mediante la información de campos como método de pago y cantidad de cuotas.
// ejemplo de respuesta:
{
"agreement_id": "2ec83742-1ed6-9374-ac14-48f57c5f5ebb",
"contract": "0002391480/RMD_TEST_022",
"due_date": "2023-08-30T00:00:00",
"offer_id": "6fd12837-42ee-42a0-ab53-e49b42f5236d",
"serial": 2800
}
Cancelación
Después de que el acuerdo sea confirmado, existe la posibilidad de cancelar la renegociación informando el identificador del acuerdo agreement_id y del cliente customer_tax_id; sin embargo, ==solo será posible la cancelación en casos en los que no se haya realizado el pago de la cuota de adhesión (primera cuota).
Boletos
Después de la confirmación del acuerdo de renegociación, ya es posible consultar el boleto generado para el pago; en escenarios en los que se haya generado más de un boleto, basta con informar el número de la cuota en el campo installment_number.
// ejemplo de respuesta:
{
"agreement_id": "2ec83742-1ed6-9374-ac14-48f57c5f5ebb",
"bar_code": "83928394300003234890001010000000003849504938",
"base64_representation": "base64",
"due_date": "2023-09-14T00:00:00",
"installment": 1,
"offer_id": "6fd12837-42ee-42a0-ab53-e49b42f5236d"
}
Recursos Disponibles
Los recursos de la API de Renegociación están disponibles en el API Reference.